/**
 * Collaborative Story Development Web Application (CSDApp) 
 * Copyright Anton Strack 2014
 *
 * This file is part of Collaborative Story Development Application (CSDApp).
 *
 * CSDApp is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * CSDApp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CSDApp. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package csdwa;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * This class provides database access to the specific resource model. It
 * provides CRUD database functionality and it stores it's results as a list.
 * Additionally, through it's methods, it provides access to determine the table
 * name, and query markers that are set for the particular DAO and thus allows
 * other code a means of interacting with this DAO to execute more advanced
 * queries.
 *
 * @author Anton Strack
 */
public class UserDao extends DaoSupport implements CsdwaDao<User> {

    private List<User> beans;

    public UserDao(Connection conn) {
        super(conn);
        this.beans = new ArrayList<User>();
        this.restoreQueryMarkers();
    }

    /**
     * Select all the beans from the bean table
     *
     * @return the row count indicating if 0 or more beans were retrieved from
     * the database.
     */
    @Override
    public int selectBeans() {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "1=1");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(this.usingQueryMarkers, SELECT_QUERY));
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select a single bean by it's id.
     *
     * @param id the id number of the bean to select.
     * @return 1 or 0, indicating a bean was retrieved or not.
     */
    @Override
    public int selectBeanById(int id) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        this.setMarker(QueryMarker.CORE_CONDITIONS, "useraccount.ID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, id);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Select all the users from the user table according to their roleId
     *
     * @param roleId the user's role that will be filtered against.
     * @param equallingRoleId weather the filter should be users having the
     * roleId or users not having the roleId. Set to true to mean select users
     * having the roleId
     * @return the row count indicating if 0 or more beans were retrieved from
     * the database.
     */
    public int selectUsersByRole(int roleId, boolean equallingRoleId) {
        int result = 0;
        this.usingQueryMarkers = this.getCoreSelectUsingQueryMarkers();
        if (equallingRoleId == true) {
            this.setMarker(QueryMarker.CORE_CONDITIONS, "useraccount.RoleID = ?");
        } else {
            this.setMarker(QueryMarker.CORE_CONDITIONS, "useraccount.RoleID <> ?");
        }
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, SELECT_QUERY));
            this.ps.setInt(1, roleId);
            result = executeSelectQuery(ps);
        } catch (SQLException ex) {
            Logger.getLogger(PostDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Clear the bean list so it doesn't contain any beans.
     */
    @Override
    public void clearDaoBeans() {
        this.beans.clear();
    }

    /**
     * Get the bean stored in the dao by it's primary id.
     *
     * @param id the id of the bean to select.
     * @return the bean if it exists in the dao or null if it doesn't
     */
    @Override
    public User getBeanById(int id) {
        User bean = null;
        if (this.beans.isEmpty() == false) {
            for (User b : this.beans) {
                if (b.getId() == id) {
                    bean = b;
                    break;
                }
            }
        }
        return bean;
    }

    /**
     * Save a bean to the database
     *
     * @param bean the bean to insert. The bean id is not required and won't be
     * used. All other bean values are required.
     * @return the auto-generated id key for the new bean row or 0 on failure.
     */
    @Override
    public int insertBean(User bean) {
        int result = 0;
        ResultSet rs;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_COLUMNS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.INSERT_VALUES);
        /*
         * HSQLDB cannot properly handle insert statements that have table identifiesr in the form of table.columnName so we need to remove the table name for inserts.
         */
        this.queryMarkers.put(QueryMarker.CORE_COLUMNS, this.prepareInsertColumns(this.getMarker(QueryMarker.CORE_COLUMNS)));
        try {
            this.ps = this.getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, INSERT_QUERY), Statement.RETURN_GENERATED_KEYS);
            this.ps.setNull(1, java.sql.Types.NULL);
            this.ps.setInt(2, bean.getRoleId());
            this.ps.setString(3, bean.getName());
            this.ps.setString(4, bean.getEmail());
            this.ps.setString(5, bean.getPassword());
            this.ps.setTimestamp(6, bean.getLoginDate());
            this.ps.setTimestamp(7, bean.getLastLoginDate());
            this.ps.setString(8, bean.getSalt());

            result = this.ps.executeUpdate();
            rs = ps.getGeneratedKeys();
            if (result != 0 && rs.next()) {
                result = rs.getInt(1); // get the auto-generated key from the successful insert operation.
            }
        } catch (SQLException ex) {
            Logger.getLogger(UserDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Update a bean in the database as well as the bean in the dao's beans map.
     *
     * @param bean the bean to update.
     * @return 1 or 0 indicating if the bean was updated or not.
     */
    @Override
    public int updateBean(User bean) {
        int result = 0;

        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.usingQueryMarkers.add(QueryMarker.UPDATE_COLUMNS_VALUES);

        String[] cols = this.splitStringByCommas(this.COLUMNS_TO_UPDATE);

        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, this.prepareUpdateColumns(cols));
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");

        try {
            this.ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, UPDATE_QUERY));
            int index = 1;
            for (String col : cols) {
                if ("name".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getName());
                    index++;
                } else if ("email".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getEmail());
                    index++;
                } else if ("password".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getPassword());
                    index++;
                } else if ("salt".equalsIgnoreCase(col)) {
                    this.ps.setString(index, bean.getSalt());
                    index++;
                } else if ("roleId".equalsIgnoreCase(col)) {
                    this.ps.setInt(index, bean.getRoleId());
                    index++;
                } else if ("loginDate".equalsIgnoreCase(col)) {
                    this.ps.setTimestamp(index, bean.getLoginDate());
                    index++;
                } else if ("lastLoginDate".equalsIgnoreCase(col)) {
                    this.ps.setTimestamp(index, bean.getLastLoginDate());
                    index++;
                }
            }
            this.ps.setInt(index, bean.getId()); // where column condition
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(ResourceTypeDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Deletes the bean from the database
     *
     * @param bean the bean to delete
     * @return 1 or 0 indicating if the bean was deleted or not.
     */
    @Override
    public int deleteBean(User bean) {
        int result = 0;
        this.usingQueryMarkers = new ArrayList<QueryMarker>();
        this.usingQueryMarkers.add(QueryMarker.CORE_CONDITIONS);
        this.usingQueryMarkers.add(QueryMarker.CORE_TABLE);
        this.setMarker(QueryMarker.CORE_CONDITIONS, "ID = ?");
        try {
            ps = getConn().prepareStatement(this.buildQueryString(usingQueryMarkers, DELETE_QUERY));
            this.ps.setInt(1, bean.getId());
            result = this.ps.executeUpdate();
        } catch (SQLException ex) {
            Logger.getLogger(UserDao.class.getName()).log(Level.SEVERE, null, ex);
        }
        return result;
    }

    /**
     * Reset the query markers to their default values for the dao.
     */
    @Override
    public void restoreQueryMarkers() {
        this.setMarker(QueryMarker.CORE_TABLE, "useraccount");
        this.setMarker(QueryMarker.CORE_COLUMNS, "useraccount.ID, useraccount.RoleID, Username, Email, Password, LoginDate, LastLoginDate, PasswordSalt");
        this.setMarker(QueryMarker.CORE_CONDITIONS, "useraccount.ID = ?");
        this.setMarker(QueryMarker.ORDER_BY_COLUMN, "Username");
        this.setMarker(QueryMarker.ORDER_BY_MODE, "ASC");
        this.setMarker(QueryMarker.LIMIT, "");
        this.setMarker(QueryMarker.INSERT_VALUES, "?, ?, ?, ?, ?, ?, ?, ?");
        this.setMarker(QueryMarker.UPDATE_COLUMNS_VALUES, "");
        this.setMarker(QueryMarker.PRIMARY_KEY, "ID");
        // special type of derived values
        this.setMarker(QueryMarker.RELATED_COLUMNS, ", role.Name AS RoleName");
        this.setMarker(QueryMarker.RELATED_CONDITIONS, " AND useraccount.RoleID = role.ID");
        this.setMarker(QueryMarker.RELATED_TABLES, ", role");
        this.COLUMNS_TO_UPDATE = "LoginDate, LastLoginDate";
    }

    /**
     * Execute the select query and place the results in beans list.
     *
     * @param ps the fully prepared PreparedStatement
     * @return the row count from the select statement
     */
    @Override
    protected int executeSelectQuery(PreparedStatement ps) {
        int result = 0;
        ResultSet rs;
        try {
            rs = ps.executeQuery();
            while (rs.next()) {
                User bean = new User();
                bean.setId(rs.getInt("useraccount.ID"));
                bean.setRoleId(rs.getInt("useraccount.RoleID"));
                bean.setName(rs.getString("Username"));
                bean.setEmail(rs.getString("Email"));
                bean.setPassword(rs.getString("Password"));
                bean.setLoginDate(rs.getTimestamp("LoginDate"));
                bean.setLastLoginDate(rs.getTimestamp("LastLoginDate"));
                bean.setSalt(rs.getString("PasswordSalt"));
                if (this.USE_RELATED_MARKERS == true) {
                    bean.setDerivedValue("RoleName", rs.getString("RoleName"));
                }
                this.processDerivedValues(bean, rs);
                this.beans.add(bean);
                result++;
            }
        } catch (SQLException ex) {
            Logger.getLogger(ActionDao.class.getName()).log(Level.SEVERE, null, ex);
        }


        return result;
    }

    /**
     * Get a list of beans
     *
     * @return a list of bean objects
     */
    @Override
    public List<User> getBeans() {
        return new ArrayList<User>(this.beans);
    }

    /**
     * Get a single bean.
     *
     * @return a single bean in the bean dao.
     */
    @Override
    public User getBean() {
        if (this.beans.isEmpty()) {
            return null;
        }
        return this.beans.get(0);
    }

    /**
     * Add a bean in the dao's bean list.
     *
     * @param bean the bean to add or update
     */
    @Override
    public void addBeanToDao(User bean) {
        this.beans.add(bean);
    }

    /**
     * This method extracts the derived values from the result set as indicated
     * by the derived columns query marker. This method then adds the values to
     * the bean's derived value map using the column name as the key.
     *
     * @param bean the bean being processed in the select query
     * @param rs the result set from the select query
     */
    public void processDerivedValues(User bean, ResultSet rs) {
        if (this.getMarker(QueryMarker.DERIVED_COLUMNS).length() > 0) {
            String[] cols = this.splitStringByCommas(this.getMarker(QueryMarker.DERIVED_COLUMNS));
            for (String column : cols) {
                try {
                    bean.setDerivedValue(column, rs.getString(column));
                } catch (SQLException ex) {
                    Logger.getLogger(DaoSupport.class.getName()).log(Level.SEVERE, null, ex);
                    ex.printStackTrace();
                } catch (Exception ex) {
                    Logger.getLogger(DaoSupport.class.getName()).log(Level.SEVERE, null, ex);
                    ex.printStackTrace();
                }
            }
        }
    }
}
